
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Welcome to the libuv documentation &#8212; libuv documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Design overview" href="design.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="design.html" title="Design overview"
             accesskey="N">next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">libuv 1.31.0 documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Welcome to the libuv documentation</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="welcome-to-the-libuv-documentation">
<h1>Welcome to the libuv documentation<a class="headerlink" href="#welcome-to-the-libuv-documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>libuv is a multi-platform support library with a focus on asynchronous I/O. It
was primarily developed for use by <a class="reference external" href="http://nodejs.org">Node.js</a>, but it’s also used by <a class="reference external" href="http://luvit.io">Luvit</a>,
<a class="reference external" href="http://julialang.org">Julia</a>, <a class="reference external" href="https://github.com/saghul/pyuv">pyuv</a>, and <a class="reference external" href="https://github.com/libuv/libuv/wiki/Projects-that-use-libuv">others</a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In case you find errors in this documentation you can help by sending
<a class="reference external" href="https://github.com/libuv/libuv">pull requests</a>!</p>
</div>
</div>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Full-featured event loop backed by epoll, kqueue, IOCP, event ports.</p></li>
<li><p>Asynchronous TCP and UDP sockets</p></li>
<li><p>Asynchronous DNS resolution</p></li>
<li><p>Asynchronous file and file system operations</p></li>
<li><p>File system events</p></li>
<li><p>ANSI escape code controlled TTY</p></li>
<li><p>IPC with socket sharing, using Unix domain sockets or named pipes (Windows)</p></li>
<li><p>Child processes</p></li>
<li><p>Thread pool</p></li>
<li><p>Signal handling</p></li>
<li><p>High resolution clock</p></li>
<li><p>Threading and synchronization primitives</p></li>
</ul>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="design.html">Design overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="guide.html">User guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading</a></li>
</ul>
</div>
</div>
<div class="section" id="downloads">
<h2>Downloads<a class="headerlink" href="#downloads" title="Permalink to this headline">¶</a></h2>
<p>libuv can be downloaded from <a class="reference external" href="http://dist.libuv.org/dist/">here</a>.</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>Installation instructions can be found in <a class="reference external" href="https://github.com/libuv/libuv/blob/master/README.md">the README</a>.</p>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="#">
              <img class="logo" src="_static/logo.png" alt="Logo"/>
            </a></p>
  <h3><a href="#">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Welcome to the libuv documentation</a><ul>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#downloads">Downloads</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
</ul>
</li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="design.html"
                        title="next chapter">Design overview</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/index.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="design.html" title="Design overview"
             >next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">libuv 1.31.0 documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Welcome to the libuv documentation</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2014-present, libuv contributors.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
    </div>
  </body>
</html>